/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * NullStemmer.java
 * Copyright (C) 2005-2012 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.core.stemmers;

/**
 * <!-- globalinfo-start --> A dummy stemmer that performs no stemming at all.
 * <p/>
 * <!-- globalinfo-end -->
 * 
 * @author FracPete (fracpete at waikato dot ac dot nz)
 * @version $Revision$
 */
public class NullStemmer implements Stemmer {

    /** for serialization */
    static final long serialVersionUID = -3671261636532625496L;

    /**
     * Returns a string describing the stemmer
     * 
     * @return a description suitable for displaying in the explorer/experimenter
     *         gui
     */
    public String globalInfo() {
        return "A dummy stemmer that performs no stemming at all.";
    }

    /**
     * Returns the word as it is.
     *
     * @param word the unstemmed word
     * @return the unstemmed word, again
     */
    public String stem(String word) {
        return new String(word);
    }

    /**
     * returns a string representation of the stemmer
     * 
     * @return a string representation of the stemmer
     */
    public String toString() {
        return getClass().getName();
    }

    /**
     * Runs the stemmer with the given options
     *
     * @param args the options
     */
    public static void main(String[] args) {
        try {
            Stemming.useStemmer(new NullStemmer(), args);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
